home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 059a / rescue19.zip / RESCUE.DOC < prev    next >
Text File  |  1993-03-12  |  20KB  |  456 lines

  1.  
  2.                                  Rescue
  3.  
  4.                                   v1.9
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                          (404) 256-9525 (Data)
  12.                          (404) 705-9104 (Data)
  13.                 (404) 256-9518 (Voice, 9am-9:30pm EST)
  14.  
  15.  
  16.  
  17.  
  18.                                 OVERVIEW
  19.                                 ________
  20.  
  21.  
  22.    You have received a call informing you that bombs have been planted in
  23.    this 100 room hotel. You also determine that there are guests currently
  24.    in their rooms. Your mission is to RESCUE all the guests.
  25.  
  26.  
  27.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  28.          created in the directory you run the door from.
  29.  
  30.  
  31.  
  32.                               INSTALLATION
  33.                               ____________
  34.  
  35.  
  36.    Installation is fairly easy and straight-forward. The following steps and
  37.    examples should have you up and running in a very short period of time.
  38.    It is assumed that you are familiar with setting up DOORS on your system.
  39.    To this end, only examples of the configuration file and Door batch file
  40.    are described.
  41.  
  42.       1) Create a directory to hold all RESCUE files
  43.  
  44.       2) Unzip RESCUExx.ZIP into the the above directory
  45.  
  46.       3) Create a configuration file, with a name of your choice, or
  47.          modify the supplied RESCUE.CFG file. A description follows:
  48.  
  49.             **                       Location of system file (See Below)
  50.             SUNRISE-80 BBS           Your BBS Name
  51.             Al                       Sysop's First name
  52.  
  53.             Lawrence                 Sysop's Last Name
  54.  
  55. |-----------------------------------------------------------------------------|
  56. | READ!     1                        CommPort  \ These 2 lines are required   |
  57. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  58. |-----------------------------------------------------------------------------|
  59.  
  60.             00000000                 Registration Number
  61.  
  62.     !   #   1                        Maximum # of Games per day
  63.                                      (Sysop gets 99, Registered version ONLY)
  64.  
  65.         #   50                       Number of Top Score Entries
  66.  
  67.         #   NONE                     Drive:\Path\Filename to contain the
  68.                                      Top Score Bulletin or enter NONE
  69.                                      for NO Bulletin creation.
  70.  
  71.         #   NONE                     Drive:\Path\Filename to contain the
  72.                                      Top Score Bulletin (Color) or enter NONE
  73.                                      for NO Bulletin creation.
  74.  
  75.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  76.                                      2 = Display ADOPT-A-DOOR message
  77.  
  78.         #   2                        Keyboard timeout value in Minutes
  79.  
  80.     !   #   0                        Time Allowed in Door
  81.                                      (Sysop = Time Remaining - REG. VERSION)
  82.  
  83.         #   Y                        Y = Allow Sysop to have 999 games
  84.                                      N = Do Not Allow Sysop 999 games
  85.  
  86.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  87.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  88.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  89.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  90.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.  
  97.     @   #   XXXX/YYYY                 Blackout Range  From/To
  98.     @   #   XXXX/YYYY                 Blackout Range  From/To
  99.     @   #   XXXX/YYYY                 Blackout Range  From/To
  100.     @   #   XXXX/YYYY                 Blackout Range  From/To
  101.     @   #   XXXX/YYYY                 Blackout Range  From/To
  102.  
  103.  
  104.           ** = Replace with ONE of the following:
  105.  
  106. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  107. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  108. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  109.                                    (Note:DOOR.SYS must be in SAME directory)
  110. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  111. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  112. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  113. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  114. C:\BBS\CHAIN.TXT                <- For WWIV systems
  115. C:\BBS\GTUSER.BBS               <- For GT Power
  116.                                    * if using this option you must put the
  117.                                      ComPort # on line 5 and the Node # on
  118.                                      line 6 of the configuration file
  119.  
  120.  
  121.  
  122.            # = Requires registration to change to a different value.
  123.            ! = See "Plays per DAY/DOOR Time" Below
  124.            @ = See "Blackout Periods" Below
  125.  
  126.                NOTE: There are NO Blank Lines in the Config File!!
  127.  
  128.  
  129.  
  130.  
  131.       4) Create a batch file or modify the RESCUE file supplied. A
  132.          description of this file follows:
  133.  
  134.             ECHO off
  135.             cd\PCB\DOORS\RESCUE       Location of RESCUE files
  136.             RESCUE RESCUE.CFG         EXE filename and CFG filename (Name
  137.                                       used in creating file in #3 above)
  138.             CD\BBS
  139.             BOARD
  140.  
  141.        5) When running in more than one node, be sure to supply a
  142.           different configuration name for each node (or see below).
  143.  
  144.        6) If running with FOssil-based multi-port boards add
  145.            /FD to the line containing the CFG name as follows:
  146.  
  147.                           RESCUE RESCUE.CFG /FD
  148.  
  149.  
  150.                MAKE-UP DAYS (Registered version only)
  151.                --------------------------------------
  152.  
  153. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  154. during the current month and prior to the current call. You control whether
  155. to allow this option, as well as the number of days the caller can make up, on
  156. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  157. configuration file, turns the option OFF, any other value (up to a max of 27)
  158. turns the option ON and dictates the number of days the caller can make up.
  159.  
  160.  
  161. NOTE:      The number of games per day is calculated as follows...
  162.  
  163.            Games Allowed per day x Number of makeup days.
  164.  
  165. Example:   Games Allowed per day = 2
  166.            Max # of makeup days  = 4
  167.  
  168. If a caller logs in on 5/8/92 and this is their first call of the month, they
  169. would have a potential of 16 games to makeup and bring them current
  170. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  171. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  172. (games allowed * max # of makeup days).
  173.  
  174.  
  175.  
  176.              HALL OF FAME BULLETINS (Registered version only)
  177.              ------------------------------------------------
  178.  
  179. The program will automatically reset the game when the first caller of the
  180. month plays the game. The score file will be cleared and a set of Hall of Fame
  181. bulletin files will be created. The files will be called SUNHOF.ASC and
  182. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same
  183. directory as the RESCUE.EXE file. You are responsible for COPYING the files
  184. to your bulletin area and renaming to a filename of your choice.
  185.  
  186. WARNING: The HOF files are cumulative files. That means they are read in each
  187.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  188.          the record of prior months winners!!!!
  189.  
  190.  
  191.  
  192.                           BLACKOUT PERIODS
  193.                           ________________
  194.  
  195.       Use the Blackout ranges option to define up to 5 time periods during
  196.       which you DO NOT want the Door to be played. If a caller tries to access
  197.       the Door during the Blackout period, they will be shown a message that
  198.       contains ALL the Blackout periods you have defined, and to try the Door
  199.       at a later time.
  200.  
  201.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  202.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  203.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  204.  
  205.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  206.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  207.                    a Blackout range.
  208.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  209.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  210.  
  211.  
  212.                           PLAYS Per DAY/DOOR Time
  213.                           _______________________
  214.  
  215.       Plays Per Day and Door Time can be controlled several ways:
  216.  
  217.       (1) You can use the Games Per Day, singular option, in the config
  218.           file above. This option, will affect ALL callers whose Security
  219.           Level is NOT defined in any of the 10 optional Security Level/
  220.           Plays Per Day entries in the config file.
  221.  
  222.       (2) You can use the Door Time, singular option, in the config file
  223.           above. This option, will affect ALL callers whose Security
  224.           Level is NOT defined in any of the 10 optional Security Level/
  225.           Plays Per Day/Door Time entries in the config file.
  226.  
  227.       (3) You can restrict the number of games a specific Security Level
  228.           will be allowed to play per day or REWARD specific Levels with
  229.           more Plays Per Day.
  230.  
  231.           Likewise, you can restrict the Play time for a specific Security
  232.           Level or REWARD specific Levels with more Door Time.
  233.  
  234.           These options are handled by the use of the 10 config
  235.           entries (000=00/00).
  236.  
  237.           The format of each entry is as follows:
  238.  
  239.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  240.                      where =  is a constant and MUST be included
  241.                      where YY is the # of games per day (must be 2 digits)
  242.                      where / is a constant and MUST be included
  243.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  244.  
  245.           If the callers Security Level is NOT defined, his/her Plays Per
  246.           Day and Door Time will be controlled by the values in items
  247.           (1) and (2), above, respectively..
  248.  
  249.           You may define up to 10 Security Levels. All unused entries must
  250.           be defined as   000=00/00
  251.         --------------------------------------------------------------------
  252.           Example: Suppose you had 3 Security Levels defined on your BBS as
  253.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  254.           wanted to set Plays Per Day as :     Subscriber=5
  255.                                            Visiting Sysop=2
  256.                                                   CoSysop=3
  257.                                                    Friend=10
  258.  
  259.           and Door Time as follows:     Subscriber=30 minutes
  260.                                     Visiting Sysop=20 minutes
  261.                                            CoSysop=10 minutes
  262.                                             Friend=remaining call time
  263.  
  264.  
  265.           You would set the Individual "Games per Day" config entry to 1 and
  266.           the individual "Door Time" to 5 minutes (these would be the
  267.           default number of games and default Time for all Security Levels
  268.           other than 20,30 or 40... make them any number you want). Next you
  269.           would replace 4 of the Security Level entries as :  020=05/30
  270.                                                               030=02/20
  271.                                                               040=03/10
  272.                                                               090=10/0
  273.  
  274.  
  275.  
  276.  
  277.                         NON-STANDARD COM SUPPORT
  278.                         ________________________
  279.  
  280.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  281.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  282.       number after the configuration filename. Let's assume your Door is
  283.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  284.       passed to your Door would be:
  285.  
  286.                             FOOBAR FOOBAR.CFG /5
  287.  
  288.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  289.       normally used with COM1. No /x parameter is needed for the standard
  290.       IRQ's.
  291.  
  292.       As an alternative, you may use an environmental variable on the command
  293.       line. To use the variable (following the example above), place a
  294.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  295.       different IRQ number for each node). The command line would now look
  296.       like this:
  297.  
  298.                           FOOBAR FOOBAR.CFG /%IRQ%
  299.  
  300.       This, in combination with the use of the environmental variables
  301.       described in the MULTI-NODE SETUP section will allow you to use one
  302.       batch file and one config file to run this door on all nodes.
  303.  
  304.  
  305.  
  306.  
  307.                            MULTI-NODE SETUP
  308.                            ________________
  309.  
  310.       All Sunrise Doors are Multi-Node capable. Each node must have the
  311.       ability to access a configuration file which will have its own system
  312.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  313.       line. There are 2 ways to accomplish this:
  314.  
  315.       (1) Create a separate configuration file for each node. The only
  316.           difference between each file would be the location of the system
  317.           file for that particular node. For example, on my system there are 2
  318.           nodes and the first line of the config files would look like this:
  319.  
  320.                         NODE1:  H:\PCB1\DOOR.SYS
  321.                         NODE2:  H:\PCB2\DOOR.SYS
  322.  
  323.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  324.  
  325.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  326.           the following PCBoard environmental variables:
  327.  
  328.                  PCBDIR    (Directory containing the System file)
  329.                  PCBDRIVE  (Drive containing the System file)
  330.  
  331.           Thus, the first line of the SINGLE configuration file, for this Door
  332.           would look like this:
  333.  
  334.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  335.  
  336.       NOTE: This option, as described, assumes that you are running PCBoard
  337.             14.5a software. The environmental variables are automatically
  338.             created by the software for each node.
  339.  
  340.             HOWEVER, if you are running other BBS software you should be able
  341.             to set the variables EXACTLY as described below, for EACH node
  342.             (more than likely in each batch file you use to bring up EACH node):
  343.  
  344.                             PCBDRIVE=C:
  345.                             ^^^^^^^^^
  346.                             PCBDIR=\NODE2
  347.                             ^^^^^^^^
  348.  
  349.             Info with a carat (^) under it, MUST be typed as is. The rest
  350.             depends on your naming conventions.
  351.  
  352.             This, in combination with the use of the optional environmental
  353.             variable described in the NON-STANDARD COM SUPPORT section, will
  354.             allow you to use one batch file and one config file to run this
  355.             door on all nodes.
  356.  
  357.  
  358.  
  359.  
  360.                                ADOPT-A-DOOR
  361.                                ____________
  362.  
  363.     Having been a Sysop for a number of years, I have had my share of problems
  364.     and frustrations getting financial support for my board's upkeep. A fellow
  365.     Sysop left a message on my board, not long ago, about a concept that was
  366.     being used by several boards around the country.
  367.  
  368.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  369.     would be the same as sending in a donation, only this way it is earmarked
  370.     for registering a particular door. In a way, the user feels he/she is
  371.     "getting something in return". As a Door author I have decided to build
  372.     this concept into each of my Door programs. The concept replaces the
  373.     usual message "tell the Sysop to register this Door" we find in most
  374.     doors.
  375.  
  376.     If the Door is unregisterd then a message appears on the opening screen
  377.     to that effect. After finishing or suspending a game, a message screen
  378.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  379.     caller to contact the Sysop to find out if there is any further details
  380.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  381.     time, etc to callers that ADOPT-A-DOOR.
  382.  
  383.     If the Door has been registered, either by the Sysop or other callers,
  384.     the names of those contributors will be displayed in the closing screen.
  385.  
  386.     NOTE: If you want to display the names of the callers that contributed
  387.           to registering the Door, you must create an ASCII file called
  388.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  389.           the name(s) of the contributors (one on each line, maximum of 5
  390.           entries, each a maximum of 30 characters long). This file must be
  391.           saved, in ASCII format, and placed in the Door directory.
  392.  
  393.  
  394.  
  395.                               LEGALITIES
  396.                               __________
  397.  
  398.  
  399.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  400.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  401.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  402.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  403.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  404.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  405.       OR BREACH OF ANY WARRANTY.
  406.  
  407.  
  408.  
  409.  
  410.  
  411.                              DISTRIBUTION
  412.                              ____________
  413.  
  414.    You may make this file available for downloading from your BBS or you may
  415.    upload it to any BBS of your choice, provided that you do not make any
  416.    changes to the contents of the archive (ZIP file). The archive and its
  417.    individual contents may not be used by any service that charges any money
  418.    whatsoever, without the written permission of the author.
  419.  
  420.  
  421.  
  422.  
  423.  
  424.                              REGISTRATION
  425.                              ____________
  426.  
  427.    Registration and the subsequent insertion of the registration number into
  428.    your configuation file, allows for the display of your BBS name on the
  429.    opening and closing screen as well as the reduction of a delay built into
  430.    the opening screen display along with the ability to change certain
  431.    values in the configuration file.
  432.  
  433.    To register your copy of RESCUE, please fill out the registration form
  434.    (REGISTER.FRM) and mail it along with the registration fee to
  435.    the name and address on the form.
  436.  
  437.    Be sure to use the proper upper/lower case when filling in your name and
  438.    BBS name, as they MUST match the way you entered them in the configuration
  439.    file.             ^^^^
  440.  
  441.    Based upon information supplied on the registration form, I will pre-
  442.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  443.    up your registration number.
  444.  
  445.  
  446.  
  447.                                  MISC
  448.                                  ____
  449.  
  450.    The latest version of RESCUE and other fine SUNRISE DOOR programs are
  451.    always available for download from SUNRISE-80 BBS.
  452.  
  453.    Remember, should you have any problems, questions or suggestions, be sure
  454.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  455.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDOnet 1:133/410
  456.